Vcenter VM PlacementSpec
The Vcenter VM PlacementSpec schema contains information used to place a virtual machine onto resources within the vCenter inventory.
{
"folder": "string",
"resource_pool": "string",
"host": "string",
"cluster": "string",
"datastore": "string"
}Virtual machine folder into which the virtual machine should be placed.
This property is currently required. In the future, if this property is missing or null, the system will attempt to choose a suitable folder for the virtual machine; if a folder cannot be chosen, the virtual machine creation operation will fail.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: Folder. When operations return a value of this schema as a response, the property will be an identifier for the resource type: Folder.
Resource pool into which the virtual machine should be placed.
This property is currently required if both host and cluster are missing or null. In the future, if this property is missing or null, the system will attempt to choose a suitable resource pool for the virtual machine; if a resource pool cannot be chosen, the virtual machine creation operation will fail.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: ResourcePool. When operations return a value of this schema as a response, the property will be an identifier for the resource type: ResourcePool.
Host onto which the virtual machine should be placed.
If host and resource_pool are both specified, resource_pool must belong to host.
If host and cluster are both specified, host must be a member of cluster.
This property may be missing or null if resource_pool or cluster is specified. If missing or null, the system will attempt to choose a suitable host for the virtual machine; if a host cannot be chosen, the virtual machine creation operation will fail.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: HostSystem. When operations return a value of this schema as a response, the property will be an identifier for the resource type: HostSystem.
Cluster into which the virtual machine should be placed.
If cluster and resource_pool are both specified, resource_pool must belong to cluster.
If cluster and host are both specified, host must be a member of cluster.
If resource_pool or host is specified, it is recommended that this property be missing or null.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: ClusterComputeResource. When operations return a value of this schema as a response, the property will be an identifier for the resource type: ClusterComputeResource.
Datastore on which the virtual machine's configuration state should be stored. This datastore will also be used for any virtual disks that are created as part of the virtual machine creation operation.
This property is currently required. In the future, if this property is missing or null, the system will attempt to choose suitable storage for the virtual machine; if storage cannot be chosen, the virtual machine creation operation will fail.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: Datastore. When operations return a value of this schema as a response, the property will be an identifier for the resource type: Datastore.